Skip to content
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

Update generated docs to align with v3.96.0 #829

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update generated docs to align with v3.96.0 #829

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
4 changes: 2 additions & 2 deletions api/add-files.api.mdx
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions api/all-by-project.api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Returns all API keys for specified project"
sidebar_label: "Get all project API keys"
hide_title: true
hide_table_of_contents: true
api: eJzNWFtzEzcU/itCL7QzGzsE6MNOpzPJkFDDAGlwSjuJJ8irY1uglTbSWQfj2f/eOdLu+rIOSaAPPNmWzvXTuXrJUUw9Ty/44emAfYaF56OES/CZUwUqa3jKzwBLZzwTWrOGik2sY76ATE0USFY4+wky5Am3BThBjAPJUy60PlqctpeFcCIHBEcal9yIHHjKCzEFMdbAE65I33UJbsET7uC6VA4kT9GVkHCfzSAXPF1yXBTEaMeNXEdqUYGnW5JHn7kyKi9znu4nDYcyCFNwPOET63KB8ejpAa8S7tXXTbYn92OzDtdsEs4JMl4h5H7t3KNTZsqrqko4KtR0dto4XlXJCo2I1kA2cBQCZzvQEFrbm+O8wMXfQpfA04nQfhdKu43/7RmvqhGJ9YU1PiJ3sL9PH5vP/+41T3hmDYIJjoqi0CoLb9z/5Ilkee+nuYJ8DFKSF3eRikK9pnD8BrQrSC42bE64klFei2T9/S1hTBjZAkKkf9sGJXfiuInP4AWzE4YzaJJjB9JbPNtRsS3yxdqvKuGlBxej4y7G85qSLCIuZm8MuEbGSan123vJIUq2W9AK1buhOSwUAfLYNwWCDV7sRGf9ee40ris1gFMlHL4UyoE/xHvYNlQ5eBR5QS7WL8eCABFjqGulFh7PPcjvl08SWOmpQO1SUMdluuSlUdclDGKkx4TfyoJbMQGXK++VNawWR7iIvKCSc8F95gCMn1n0vbLQVsiQD6tDCRqQzEMnjNchz30PpMItwrmCm22y+ow6RGQZ3VoJv9MDfnG5w4dLnlzu8CIcd/zoEJPVXdL2tPXmko82C/hhqFFvrARNFxTIde/5dl1pWs2dFTrhaFHoYw05GPQP4aHmcl8GU+ZjcPfrGZvt6w2gkAJF50IGVLoAPdvVYo6EZGdwXYLHh/SaNiiWPLOSNC9seSWVvPI2B5wpM726cTYEWxg9wqDT3vGEx9tRlXBr4N0kTCXrXSWI3dEmGk+PnbPurG6hw0UBklMr/24RR1YueDVqoHrSherciBJn1qmvIH8MqzJIAoPEFAz/OUF42gXhxLqxkhLMjyHQzqpXxuJVKDuIAdZVtHSr4E8bLc+6QL21yE5saX4wVBx4W7oMAk6TWl6DkSm1/hkhoX4KWekULoJZr25waD+D4enFiCbfL3vWSap6z6m9IBjqOHExoSEubQkSPo8T9nNio+JhabeZQlxpcMZT3p8f9OtpxPeX7YxU9UWh9sJaRda4ebP6lE7zlM8QC5/2+6Ioemj1FKCnbKczvgRDcQqSRQmMmMmUxr339HSx2K+cbGs5KeH1XkC/xyBc8Cp+OWkK/KsPQ6oB78sC3O1iNk0LxOzVhyFDImfKs+bp4oZIqKKaA2tzzbObGZg4VM6EZx6QHZwc9ti/tmSZMMyOUSjD/JbouRLsI8FMnP1pjcleINsLJB8ZGFlYZbDHjkpkY2CZcDAp9SO2MjT4FTWHs8LegPOPHoBQbGoD8ycIudE148rCk2aV+2fv8HSwF4/CKjeLHGsy/qJd95QyaZecrUUDH3tmLDIHmc1zMBIkQ0tQtgOmMiyszyxkZ8K8MhkwhQHZMTCPlt5GGabt1PdWtorPm+s3pY8yExvMqjNtGEKUdHWn3Xh1qgXSxMDOjt8Pg1EOJuDAZDRRUvRH8vmT3n6Y+63HXIQwq+14CRj+aGhG+/Zvic4K1dazh/1BUWOM8AX7hRYqbliUjss6mS/4/GC1MpLmdH2VbDN6lPCZ9UgMy+VYeDh3uqroOEJIeS6Vpw1ftuv5rU78clYnzq/sNitjWVr7u6SuSzxUg7lwKpz/73qbsDSLdZ2tPS02FbXGOsZXZfQwy6DANc5O99koqy+PhwRySS/RZsRWRgbpO636/SgQxCz/o7Ux1IfYF/4DpwqC5Q==
api: eJzNWFlv20YQ/iubeUkL0JLjJH0gigI2YqdKkMR15KaFLTgr7kjahNyld4eSFYH/vZjlodNX0oc8iVrOzM58c3MBJMce4gs4PO2Jrzj3MIhAoU+czklbAzGcIRXOeCHTVDRUYmSd8DkmeqRRidzZL5gQRGBzdJIZewpikGl6ND9tX+bSyQwJHd+4ACMzhBhyOUY5TBEi0HzfdYFuDhE4vC60QwUxuQIj8MkEMwnxAmieM6MdNnIdX0saPb9lefybaaOzIoN4P2o4tCEco4MIRtZlkqqj5wdQRuD1t3W2Zw9js45WdJLOSVZeE2Z+5dyT02YMZVlGQJpSPjttDC/LaIlGhVZPNXDkkiY70JBpamfHWU7zv2VaIMQjmfpdKO1W/rcXUJYDFutza3yF3MH+Pv+su//DW4ggsYbQBENlnqc6CT7ufvFMsniwa64wG6JSbMV9pDLXbzkc74B2CcnFms4RaFXJa5Gsn98zxoyRzTFE+t06rAGx6crNNHm18q+MAG9y7dAf0k5XrLP2dYaeZJYLO2pSTAQBsrJn03PBwvvl9l6xQJpgI3SnqFR6Oveovl9VliAKz3m364KlI+6Xf5hrFvnUNzVF9F7dJTR49F7fbEsN2Va2oRAvoDD6usBeFVxVjm0E3q0y0WXae22NqMWx+2WWc5ZfgE8covETS75T5KmVKoTg8lBhisTQkZPGpyG1fAeVpg3CqcbZJll9xkW5YhncWny+0wK4uNxhwyVElzusCMdbdmwRs9bbpO1pa80lDLg6QuHRnRRp+jB3M2XwMAcpswo7M+igFmQeJOS8ptyUsVLAD0ONemcVplzZOSrr3nN3XTFFNkT3oBq97EsPICVLMj1OMUND/jE83IkexrDRvt4hSSVJbr1QAZVtgF7sajFHUokzvC7Q02N6TRuhC0is4pvntrhSWl15myFNtBlfzZwNvg2jRxh02ncQQfV2UEZgDX4YhalktasEsTvaRGPpsXPWndUttD/PUQG38u8WcWTVHMpBA9WzbajOjSxoYp3+hurHsCqCJDTETEHxnxOE59sgnFg31Eqh+TEE2ln1yli6CjWQKMC6jJbtkvzTRsuLbaDeWxIntjA/GCoOvS1cggGnUS2vwcgUafozQsKlE5PCaZoHtd7MqG+/ooH4YsCT782edYqr8EvudYSG21+1mPCkFLcEEUyrCfsls3HxsLzbjLFaaWgCMXSnB916tPDdRTvwlF2Z672wVrE2btqsPoVLIYYJUe7jblfmeYdsOkbsaLvViF6j4ThFJSoJgplZlca8j+y6qn4vjWxrOV8C9V7A/4coXbCqejhpCvybT32uAR+LHN3tYtZVC8Tizae+ICYX2ovGddWGyKiSnqJoc82L2QRN1VEn0guPJA5ODjviX1uIRBphhyS1EX5D9FRL8ZlhZs7uuMZkL5DtBZLPAo3KrTbUEUcFiSGKRDocFekTsVQ02FXdHM5yO0PnnzwCoaqp9cyfKNVaF69WFoiaVe6fvcPT3l51FFa5ScWxIuMv3nVPOZN2ydmY5umpF8aScJjYLEOjUAmyDGU7iWsjwvosQnZGwmuToNAUkB2i8GTZN9qI1I59Z6mr/Lq+fnP6aDOyQa060/ohRPmu7bWgenWaSuKJQZwdf+wHpRyO0KFJeLzl6K/Ip886+2GIt54yGcKs1uM1UvjQ0Mzp7WeJaHMba+vZ4z5Q1BgT3lA3T6UOy1pIx0WdzBcwPViujHxzvLpKthk9iGBiPTHDYjGUHs9dWpZ8XEHIea605w1ftev5rUb8clYnzq/iNi2rsrTyuaSuSxCqwVQ6Hc7/93ubsDTz1TtbfVpsSm6NdYwvy+hhkmBOK5xb3WetrL4+7jPIBXuizYiNjAzSd2r1+1EgqLL8j1bHUB+qvvAfYzyC5Q==
sidebar_class_name: "get api-method"
info_path: api//tolgee-api
custom_edit_url: null
Expand Down Expand Up @@ -38,7 +38,7 @@ Returns all API keys for specified project

OK

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>_embedded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>apiKeys</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"ID of the API key","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description"}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Username of user owner"}}></SchemaItem><SchemaItem collapsible={false} name={"userFullName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full name of user owner"}}></SchemaItem><SchemaItem collapsible={false} name={"projectId"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Api key's project ID","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"projectName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Api key's project name"}}></SchemaItem><SchemaItem collapsible={false} name={"expiresAt"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp of API key expiraion","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"lastUsedAt"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp of API key last usage","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"uniqueItems":true,"type":"array","description":"Api key's permission scopes","example":["screenshots.upload","screenshots.delete","translations.edit","screenshots.view","translations.view","keys.edit"],"items":{"type":"string","description":"Api key's permission scopes","example":"[\"screenshots.upload\",\"screenshots.delete\",\"translations.edit\",\"screenshots.view\",\"translations.view\",\"keys.edit\"]"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>page</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"totalElements"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"number"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"_embedded\": {\n \"apiKeys\": [\n {\n \"id\": 0,\n \"description\": \"string\",\n \"username\": \"string\",\n \"userFullName\": \"string\",\n \"projectId\": 0,\n \"projectName\": \"string\",\n \"expiresAt\": 0,\n \"lastUsedAt\": 0,\n \"scopes\": [\n \"screenshots.upload\",\n \"screenshots.delete\",\n \"translations.edit\",\n \"screenshots.view\",\n \"translations.view\",\n \"keys.edit\"\n ]\n }\n ]\n },\n \"page\": {\n \"size\": 0,\n \"totalElements\": 0,\n \"totalPages\": 0,\n \"number\": 0\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>_embedded</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>apiKeys</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description"}}></SchemaItem><SchemaItem collapsible={false} name={"expiresAt"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp of API key expiraion","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"ID of the API key","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"lastUsedAt"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Timestamp of API key last usage","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"projectId"} required={true} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","description":"Api key's project ID","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"projectName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Api key's project name"}}></SchemaItem><SchemaItem collapsible={false} name={"scopes"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"uniqueItems":true,"type":"array","description":"Api key's permission scopes","example":["screenshots.upload","screenshots.delete","translations.edit","screenshots.view","translations.view","keys.edit"],"items":{"type":"string","description":"Api key's permission scopes","example":"[\"screenshots.upload\",\"screenshots.delete\",\"translations.edit\",\"screenshots.view\",\"translations.view\",\"keys.edit\"]"}}}></SchemaItem><SchemaItem collapsible={false} name={"userFullName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Full name of user owner"}}></SchemaItem><SchemaItem collapsible={false} name={"username"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Username of user owner"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>page</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"number"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"size"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"totalElements"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"_embedded\": {\n \"apiKeys\": [\n {\n \"description\": \"string\",\n \"expiresAt\": 0,\n \"id\": 0,\n \"lastUsedAt\": 0,\n \"projectId\": 0,\n \"projectName\": \"string\",\n \"scopes\": [\n \"screenshots.upload\",\n \"screenshots.delete\",\n \"translations.edit\",\n \"screenshots.view\",\n \"translations.view\",\n \"keys.edit\"\n ],\n \"userFullName\": \"string\",\n \"username\": \"string\"\n }\n ]\n },\n \"page\": {\n \"number\": 0,\n \"size\": 0,\n \"totalElements\": 0,\n \"totalPages\": 0\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad Request

Expand Down
Loading
Loading