OAS 2.1 cleanup#38
Conversation
OAS 2.1 cleanup per programmer answers (Q1–Q5, A1–A5)
There was a problem hiding this comment.
Tohle nám způsobí, že když bude chyba někde, tak nám bude chybět část dokumentace. Radši ať ten script umře a opraví se to, než to pushnem
| @@ -114,7 +114,7 @@ info: | |||
| As part of our commitment to data security, you are required to obtain a | |||
| <b>Bearer token</b> from Foxentry. If you are a new user and do not have an | |||
| API key, please fill out our registration form at | |||
There was a problem hiding this comment.
Tady by to chtělo přepsat i ten text trochu. Napsal bych tam něco jako ať se zaregistrujou do naši appky. Ať vyplněj registrační formulář zní jako by něco měli vyplnit a my se jim ozvat
| those via `location`, as an IP address may be less precise. | ||
| examples: | ||
| - 127.0.1.1 | ||
| - 2001:db8::8a2e:370:7334 |
There was a problem hiding this comment.
Nejsem si jistej, jestli ipv6 podporujem? To bude třeba se Mrázka doptat
| which indicates a non-specific error. | ||
| example: false | ||
| proposal: | ||
| enum: |
There was a problem hiding this comment.
Tohle je doopravdy enum
| example: false | ||
| proposal: | ||
| enum: | ||
| type: string |
There was a problem hiding this comment.
Tohle je doopravdy enum
| example: false | ||
| proposal: | ||
| enum: | ||
| type: string |
There was a problem hiding this comment.
Tohle je doopravdy enum
| example: false | ||
| proposal: | ||
| enum: | ||
| type: string |
There was a problem hiding this comment.
Tohle je doopravdy enum
| example: false | ||
| proposal: | ||
| enum: | ||
| type: string |
There was a problem hiding this comment.
Tohle je doopravdy enum
2 participants
API 2.1 cleanup
Consistency and accuracy pass over the 2.1 spec. Bundles and lints clean (
redocly lint→ 0 warnings).Schema
proposal(all*ValidationResultschemas): modelled asstringwith examples instead of a fixed enum. The value is generated from the validity ofresult, the validity ofresultCorrected, and the presence ofsuggestions, so the set of values isn't fixed.description: modelled as a nullable string (type: [string, "null"]) rather than an enum, since the message text can change and may be null for some errors.client.ip: now documented as an IPv4 or IPv6 address (used for geolocation), with examples for both.Servers & versioning
/v2.1path server and the duplicated per-operationserversblocks. The API version is selected through theApi-Versionheader.Content
dataSourcedefinitions.app.foxentry.com/registration.Tooling
bundle.sh.Verification