-
Notifications
You must be signed in to change notification settings - Fork 43
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.
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
Added documentation for Broker's rate limits #1728
Open
Ceredron
wants to merge
2
commits into
master
Choose a base branch
from
docs/broker-rate-limits
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Rate Limits | ||
| linktitle: Rate Limits | ||
| description: Altinn 3 Broker Capabilities and Features. | ||
| tags: [] | ||
| toc: true | ||
| weight: 40 | ||
| --- | ||
|
|
||
| ## Rate limits | ||
|
|
||
| Rate limit applies per subscription key (Ocp-Apim-Subscription-Key). Contact us for more capacity. | ||
|
|
||
| - `POST /broker/api/v1/filetransfer` | ||
| - Description: Initialize a file transfer | ||
| - Rate limit: 60 calls per minute | ||
|
|
||
| - `POST /broker/api/v1/filetransfer/{fileTransferId}/upload` | ||
| - Description: Upload to an initialized file using a binary stream | ||
| - Rate limit: 60 calls per minute | ||
|
|
||
| - `POST /broker/api/v1/filetransfer/upload` | ||
| - Description: Initialize and upload a file using form-data | ||
| - Rate limit: 60 calls per minute | ||
|
|
||
| - `GET /broker/api/v1/filetransfer/{fileTransferId}` | ||
| - Description: Get information about the file and its current status | ||
| - Rate limit: 60 calls per minute | ||
|
|
||
| - `GET /broker/api/v1/filetransfer/{fileTransferId}/details` | ||
| - Description: Get more detailed information about the file upload for auditing and troubleshooting purposes | ||
| - Rate limit: 10 calls per minute | ||
|
|
||
| - `GET /broker/api/v1/filetransfer` | ||
| - Description: Search files that can be accessed by the caller according to specified filters | ||
| - Rate limit: 10 calls per minute | ||
|
|
||
| - `GET /broker/api/v1/filetransfer/{fileTransferId}/download` | ||
| - Description: Downloads the file | ||
| - Rate limit: 60 calls per minute | ||
|
|
||
| - `POST /broker/api/v1/filetransfer/{fileTransferId}/confirmdownload` | ||
| - Description: Confirms that the file has been downloaded | ||
| - Rate limit: 60 calls per minute | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Hastighetsbegrensning | ||
| linktitle: Hastighetsbegrensning | ||
| description: Referansedokumentasjon for Altinn 3 Formidling | ||
| tags: [] | ||
| toc: true | ||
| weight: 40 | ||
| --- | ||
|
|
||
| ## Hastighetsbegrensning av API-forespørsler | ||
|
|
||
| Hastighetsbegrensning av API-forespørsler gjelder per abonnementnøkkel (Ocp-Apim-Subscription-Key). Kontakt oss for mer kapasitet. | ||
|
|
||
| - `POST /broker/api/v1/filetransfer` | ||
| - Beskrivelse: Initialiser en filoverføring | ||
| - Hastighetsbegrensning: 60 kall per minutt | ||
|
|
||
| - `POST /broker/api/v1/filetransfer/{fileTransferId}/upload` | ||
| - Beskrivelse: Last opp til en initialisert fil ved hjelp av en binær strøm | ||
| - Hastighetsbegrensning: 60 kall per minutt | ||
|
|
||
| - `POST /broker/api/v1/filetransfer/upload` | ||
| - Beskrivelse: Initialiser og last opp en fil ved hjelp av form-data | ||
| - Hastighetsbegrensning: 60 kall per minutt | ||
|
|
||
| - `GET /broker/api/v1/filetransfer/{fileTransferId}` | ||
| - Beskrivelse: Få informasjon om filen og dens nåværende status | ||
| - Hastighetsbegrensning: 60 kall per minutt | ||
|
|
||
| - `GET /broker/api/v1/filetransfer/{fileTransferId}/details` | ||
| - Beskrivelse: Få mer detaljert informasjon om filopplastingen for revisjons- og feilsøkingsformål | ||
| - Hastighetsbegrensning: 10 kall per minutt | ||
|
|
||
| - `GET /broker/api/v1/filetransfer` | ||
| - Beskrivelse: Søk etter filer som kan nås av innringeren i henhold til spesifiserte filtre | ||
| - Hastighetsbegrensning: 10 kall per minutt | ||
|
|
||
| - `GET /broker/api/v1/filetransfer/{fileTransferId}/download` | ||
| - Beskrivelse: Last ned filen | ||
| - Hastighetsbegrensning: 60 kall per minutt | ||
|
|
||
| - `POST /broker/api/v1/filetransfer/{fileTransferId}/confirmdownload` | ||
| - Beskrivelse: Bekrefter at filen er lastet ned | ||
| - Hastighetsbegrensning: 60 kall per minutt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider adding a single paragraph to justify the Rate Limits;
Something like "We have introduced the following rate limits to balance the resource usage per party and avoid overloading the infrastructure. Using Events/Webhooks in your solution should eliminate the need for polling many of these operations". With maybe a link to the Events page?