Skip to content

fix useAuth decorator link to authentication section #2317

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
daviwil merged 5 commits into from
Aug 30, 2023
Merged

fix useAuth decorator link to authentication section #2317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8de1bbe
fix useAuth decorator link to authentication section
rahimi-ali Aug 21, 2023
4fdc49d
Merge branch 'main' into fix-useauth-link
markcowl Aug 28, 2023
9b3a7b2
Update decorator docstring
daviwil Aug 30, 2023
6f4edd8
Merge remote-tracking branch 'origin/main' into fix-useauth-link
daviwil Aug 30, 2023
afcd18b
Rush change file
daviwil Aug 30, 2023
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
10 changes: 10 additions & 0 deletions common/changes/@typespec/http/fix-useauth-link_2023-08-30-11-46.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"changes": [
{
"packageName": "@typespec/http",
"comment": "",
"type": "none"
}
],
"packageName": "@typespec/http"
}
2 changes: 1 addition & 1 deletion docs/standard-library/http/reference/decorators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ op create(): {@statusCode: 201 | 202}

### `@useAuth` {#@TypeSpec.Http.useAuth}

Specify this service authentication. See the [documentation in the Http library][https://microsoft.github.io/typespec/standard-library/rest/authentication] for full details.
Specify this service authentication. See the [documentation in the Http library](https://microsoft.github.io/typespec/standard-library/http/authentication) for full details.

```typespec
@TypeSpec.Http.useAuth(auth: {} | Union | {}[])
Expand Down
2 changes: 1 addition & 1 deletion packages/http/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ op create(): {@statusCode: 201 | 202}

#### `@useAuth`

Specify this service authentication. See the [documentation in the Http library][https://microsoft.github.io/typespec/standard-library/rest/authentication] for full details.
Specify this service authentication. See the [documentation in the Http library](https://microsoft.github.io/typespec/standard-library/http/authentication) for full details.

```typespec
@TypeSpec.Http.useAuth(auth: {} | Union | {}[])
Expand Down
2 changes: 1 addition & 1 deletion packages/http/lib/http-decorators.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ extern dec server(
);

/**
* Specify this service authentication. See the [documentation in the Http library][https://microsoft.github.io/typespec/standard-library/rest/authentication] for full details.
* Specify this service authentication. See the [documentation in the Http library](https://microsoft.github.io/typespec/standard-library/http/authentication) for full details.
*
* @param auth Authentication configuration. Can be a single security scheme, a union(either option is valid authentication) or a tuple(Must use all authentication together)
* @example
Expand Down
2 changes: 1 addition & 1 deletion packages/http/src/operations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export function getHttpService(
}

/**
* @deprecated use `getAllHttpServices` or `resolveHttpOperations` manually
* @deprecated use `getAllHttpServices` instead
*/
export function getAllRoutes(
program: Program,
Expand Down