Skip to content

Commit 083e992

Browse files
helmut-hoffer-von-ankershoffenhelmut-hoffer-von-ankershoffen
committed
docs: update URLs in openapi spec and downstream docs
1 parent ec34fce commit 083e992

File tree

9 files changed

+90
-1003
lines changed

9 files changed

+90
-1003
lines changed

‎API_REFERENCE_v1.md

Lines changed: 2 additions & 327 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Base URLs:
1616
- oAuth2 authentication.
1717

1818
- Flow: authorizationCode
19-
- Authorization URL = [https://dev-8ouohmmrbuh2h4vu.eu.auth0.com/authorize](https://dev-8ouohmmrbuh2h4vu.eu.auth0.com/authorize)
20-
- Token URL = [https://dev-8ouohmmrbuh2h4vu.eu.auth0.com/oauth/token](https://dev-8ouohmmrbuh2h4vu.eu.auth0.com/oauth/token)
19+
- Authorization URL = [https://aignostics-platform.eu.auth0.com/authorize](https://aignostics-platform.eu.auth0.com/authorize)
20+
- Token URL = [https://aignostics-platform.eu.auth0.com/oauth/token](https://aignostics-platform.eu.auth0.com/oauth/token)
2121

2222
|Scope|Scope Description|
2323
|---|---|
@@ -284,92 +284,6 @@ To perform this operation, you must be authenticated by means of one of the foll
284284
OAuth2AuthorizationCodeBearer
285285

286286

287-
### get_me_v1_me_get
288-
289-
290-
291-
> Code samples
292-
293-
```python
294-
import requests
295-
headers = {
296-
'Accept': 'application/json',
297-
'Authorization': 'Bearer {access-token}'
298-
}
299-
300-
r = requests.get('/api/v1/me', headers = headers)
301-
302-
print(r.json())
303-
304-
```
305-
306-
```javascript
307-
308-
const headers = {
309-
'Accept':'application/json',
310-
'Authorization':'Bearer {access-token}'
311-
};
312-
313-
fetch('/api/v1/me',
314-
{
315-
method: 'GET',
316-
317-
headers: headers
318-
})
319-
.then(function(res) {
320-
return res.json();
321-
}).then(function(body) {
322-
console.log(body);
323-
});
324-
325-
```
326-
327-
`GET /v1/me`
328-
329-
*Get Me*
330-
331-
> Example responses
332-
333-
> 200 Response
334-
335-
```json
336-
{
337-
"organization": {
338-
"aignostics_bucket_hmac_access_key_id": "string",
339-
"aignostics_bucket_hmac_secret_access_key": "string",
340-
"aignostics_bucket_name": "string",
341-
"aignostics_bucket_protocol": "string",
342-
"aignostics_logfire_token": "string",
343-
"aignostics_sentry_dsn": "string",
344-
"display_name": "string",
345-
"id": "string",
346-
"name": "string"
347-
},
348-
"user": {
349-
"email": "string",
350-
"email_verified": true,
351-
"family_name": "string",
352-
"given_name": "string",
353-
"id": "string",
354-
"name": "string",
355-
"nickname": "string",
356-
"picture": "string",
357-
"updated_at": "2019-08-24T14:15:22Z"
358-
}
359-
}
360-
```
361-
362-
#### Responses
363-
364-
|Status|Meaning|Description|Schema|
365-
|---|---|---|---|
366-
|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Successful Response|[MeReadResponse](#schemamereadresponse)|
367-
368-
369-
To perform this operation, you must be authenticated by means of one of the following methods:
370-
OAuth2AuthorizationCodeBearer
371-
372-
373287
### list_application_runs_v1_runs_get
374288

375289

@@ -1572,190 +1486,6 @@ ItemStatus
15721486
|ItemStatus|ERROR_SYSTEM|
15731487
|ItemStatus|SUCCEEDED|
15741488

1575-
### MeReadResponse
1576-
1577-
1578-
1579-
1580-
1581-
1582-
```json
1583-
{
1584-
"organization": {
1585-
"aignostics_bucket_hmac_access_key_id": "string",
1586-
"aignostics_bucket_hmac_secret_access_key": "string",
1587-
"aignostics_bucket_name": "string",
1588-
"aignostics_bucket_protocol": "string",
1589-
"aignostics_logfire_token": "string",
1590-
"aignostics_sentry_dsn": "string",
1591-
"display_name": "string",
1592-
"id": "string",
1593-
"name": "string"
1594-
},
1595-
"user": {
1596-
"email": "string",
1597-
"email_verified": true,
1598-
"family_name": "string",
1599-
"given_name": "string",
1600-
"id": "string",
1601-
"name": "string",
1602-
"nickname": "string",
1603-
"picture": "string",
1604-
"updated_at": "2019-08-24T14:15:22Z"
1605-
}
1606-
}
1607-
1608-
```
1609-
1610-
MeReadResponse
1611-
1612-
#### Properties
1613-
1614-
|Name|Type|Required|Restrictions|Description|
1615-
|---|---|---|---|---|
1616-
|organization|[OrganizationReadResponse](#schemaorganizationreadresponse)|true|none|This model corresponds to the response schema returned fromAuth0 GET /v2/organizations/{id} endpoint, flattens out the metadata outand doesn't return branding or token_quota objects.For details, see:https://auth0.com/docs/api/management/v2/organizations/get-organizations-by-id|
1617-
|user|[UserReadResponse](#schemauserreadresponse)|true|none|This model corresponds to the response schema returned fromAuth0 GET /v2/users/{id} endpoint.For details, see:https://auth0.com/docs/api/management/v2/users/get-users-by-id|
1618-
1619-
### OrganizationReadResponse
1620-
1621-
1622-
1623-
1624-
1625-
1626-
```json
1627-
{
1628-
"aignostics_bucket_hmac_access_key_id": "string",
1629-
"aignostics_bucket_hmac_secret_access_key": "string",
1630-
"aignostics_bucket_name": "string",
1631-
"aignostics_bucket_protocol": "string",
1632-
"aignostics_logfire_token": "string",
1633-
"aignostics_sentry_dsn": "string",
1634-
"display_name": "string",
1635-
"id": "string",
1636-
"name": "string"
1637-
}
1638-
1639-
```
1640-
1641-
OrganizationReadResponse
1642-
1643-
#### Properties
1644-
1645-
|Name|Type|Required|Restrictions|Description|
1646-
|---|---|---|---|---|
1647-
|aignostics_bucket_hmac_access_key_id|any|true|none|none|
1648-
1649-
anyOf
1650-
1651-
|Name|Type|Required|Restrictions|Description|
1652-
|---|---|---|---|---|
1653-
|» *anonymous*|string|false|none|none|
1654-
1655-
or
1656-
1657-
|Name|Type|Required|Restrictions|Description|
1658-
|---|---|---|---|---|
1659-
|» *anonymous*|null|false|none|none|
1660-
1661-
continued
1662-
1663-
|Name|Type|Required|Restrictions|Description|
1664-
|---|---|---|---|---|
1665-
|aignostics_bucket_hmac_secret_access_key|any|true|none|none|
1666-
1667-
anyOf
1668-
1669-
|Name|Type|Required|Restrictions|Description|
1670-
|---|---|---|---|---|
1671-
|» *anonymous*|string|false|none|none|
1672-
1673-
or
1674-
1675-
|Name|Type|Required|Restrictions|Description|
1676-
|---|---|---|---|---|
1677-
|» *anonymous*|null|false|none|none|
1678-
1679-
continued
1680-
1681-
|Name|Type|Required|Restrictions|Description|
1682-
|---|---|---|---|---|
1683-
|aignostics_bucket_name|any|true|none|none|
1684-
1685-
anyOf
1686-
1687-
|Name|Type|Required|Restrictions|Description|
1688-
|---|---|---|---|---|
1689-
|» *anonymous*|string|false|none|none|
1690-
1691-
or
1692-
1693-
|Name|Type|Required|Restrictions|Description|
1694-
|---|---|---|---|---|
1695-
|» *anonymous*|null|false|none|none|
1696-
1697-
continued
1698-
1699-
|Name|Type|Required|Restrictions|Description|
1700-
|---|---|---|---|---|
1701-
|aignostics_bucket_protocol|any|true|none|none|
1702-
1703-
anyOf
1704-
1705-
|Name|Type|Required|Restrictions|Description|
1706-
|---|---|---|---|---|
1707-
|» *anonymous*|string|false|none|none|
1708-
1709-
or
1710-
1711-
|Name|Type|Required|Restrictions|Description|
1712-
|---|---|---|---|---|
1713-
|» *anonymous*|null|false|none|none|
1714-
1715-
continued
1716-
1717-
|Name|Type|Required|Restrictions|Description|
1718-
|---|---|---|---|---|
1719-
|aignostics_logfire_token|any|true|none|none|
1720-
1721-
anyOf
1722-
1723-
|Name|Type|Required|Restrictions|Description|
1724-
|---|---|---|---|---|
1725-
|» *anonymous*|string|false|none|none|
1726-
1727-
or
1728-
1729-
|Name|Type|Required|Restrictions|Description|
1730-
|---|---|---|---|---|
1731-
|» *anonymous*|null|false|none|none|
1732-
1733-
continued
1734-
1735-
|Name|Type|Required|Restrictions|Description|
1736-
|---|---|---|---|---|
1737-
|aignostics_sentry_dsn|any|true|none|none|
1738-
1739-
anyOf
1740-
1741-
|Name|Type|Required|Restrictions|Description|
1742-
|---|---|---|---|---|
1743-
|» *anonymous*|string|false|none|none|
1744-
1745-
or
1746-
1747-
|Name|Type|Required|Restrictions|Description|
1748-
|---|---|---|---|---|
1749-
|» *anonymous*|null|false|none|none|
1750-
1751-
continued
1752-
1753-
|Name|Type|Required|Restrictions|Description|
1754-
|---|---|---|---|---|
1755-
|display_name|string|true|none|none|
1756-
|id|string|true|none|none|
1757-
|name|string|true|none|none|
1758-
17591489
### OutputArtifactReadResponse
17601490

17611491

@@ -2286,61 +2016,6 @@ continued
22862016
|---|---|---|---|---|
22872017
|items|[[PayloadItem](#schemapayloaditem)]|true|none|none|
22882018

2289-
### UserReadResponse
2290-
2291-
2292-
2293-
2294-
2295-
2296-
```json
2297-
{
2298-
"email": "string",
2299-
"email_verified": true,
2300-
"family_name": "string",
2301-
"given_name": "string",
2302-
"id": "string",
2303-
"name": "string",
2304-
"nickname": "string",
2305-
"picture": "string",
2306-
"updated_at": "2019-08-24T14:15:22Z"
2307-
}
2308-
2309-
```
2310-
2311-
UserReadResponse
2312-
2313-
#### Properties
2314-
2315-
|Name|Type|Required|Restrictions|Description|
2316-
|---|---|---|---|---|
2317-
|email|string|true|none|none|
2318-
|email_verified|boolean|true|none|none|
2319-
|family_name|string|true|none|none|
2320-
|given_name|string|true|none|none|
2321-
|id|string|true|none|none|
2322-
|name|string|true|none|none|
2323-
|nickname|any|true|none|none|
2324-
2325-
anyOf
2326-
2327-
|Name|Type|Required|Restrictions|Description|
2328-
|---|---|---|---|---|
2329-
|» *anonymous*|string|false|none|none|
2330-
2331-
or
2332-
2333-
|Name|Type|Required|Restrictions|Description|
2334-
|---|---|---|---|---|
2335-
|» *anonymous*|null|false|none|none|
2336-
2337-
continued
2338-
2339-
|Name|Type|Required|Restrictions|Description|
2340-
|---|---|---|---|---|
2341-
|picture|string|true|none|none|
2342-
|updated_at|string(date-time)|true|none|none|
2343-
23442019
### ValidationError
23452020

23462021

0 commit comments

Comments
 (0)