Skip to content

chore: improve comment of grant consent route #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 19, 2024
Merged

chore: improve comment of grant consent route #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/api/application-api/grant-consent.api.mdx
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/api/gds/get-application-token-profile.api.mdx
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/api/gds/get-subscription-overview.api.mdx
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/api/gds/get-user-profile.api.mdx
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/gds/onboard-cloud-connector.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Onboarding information of the cloud connector

Successful

</div><div><MimeTabs schemaType={"response"}><TabItem label={"text/plain"} value={"text/plain"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"activationCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The 12-digit activation code for the machine onboarding","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"expiry"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry date","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"activationCode\": \"string\",\n \"expiry\": \"2024-02-19T09:55:09.200Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"activationCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The 12-digit activation code for the machine onboarding","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"expiry"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry date","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"activationCode\": \"string\",\n \"expiry\": \"2024-02-19T09:55:09.200Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"text/json"} value={"text/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"activationCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The 12-digit activation code for the machine onboarding","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"expiry"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry date","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"activationCode\": \"string\",\n \"expiry\": \"2024-02-19T09:55:09.200Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><div><MimeTabs schemaType={"response"}><TabItem label={"text/plain"} value={"text/plain"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"activationCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The 12-digit activation code for the machine onboarding","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"expiry"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry date","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"activationCode\": \"string\",\n \"expiry\": \"2024-02-19T14:06:46.901Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"activationCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The 12-digit activation code for the machine onboarding","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"expiry"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry date","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"activationCode\": \"string\",\n \"expiry\": \"2024-02-19T14:06:46.901Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem><TabItem label={"text/json"} value={"text/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"activationCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The 12-digit activation code for the machine onboarding","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"expiry"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Expiry date","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"activationCode\": \"string\",\n \"expiry\": \"2024-02-19T14:06:46.901Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request

Expand Down
2 changes: 1 addition & 1 deletion src/api/ApplicationApi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
"Me"
],
"summary": "Grant Consent",
"description": "Grant consent to a subject on behalf of a user.",
"description": "Grant consent to a subject on behalf of a user. Get the result from EvaluateConsent. Note that\r\n this route is eventually consistent. So EvaluateConsent might take some time to take over the granting of the consent.",
"operationId": "GrantConsent",
"parameters": [
{
Expand Down