# yyna.xyz docs

## webring

### what you need to be added

in order to add your website to a webring, you will need:

- a unique id, used for self referencing
  - you can find all of the current webring members by navigating to  
    `https://party.yyna.xyz/u/yyna.xyz/webrings/<webring id>.json`
- an url to your website
- a 88x31 image, used for preview
  - if needed, i can host the image for you
- a short description

these should be compiled in a simple json object, as shown under:

```json
{
  "id": "yyna",
  "url": "https://yyna.xyz",
  "image": "https://cyber.dabamos.de/88x31/banshee.gif",
  "desc": "yyna's website"
}
```

### using the webring on your website

in order to get the previous and next websites in your webring, you need to send a GET request to `https://yyna.xyz/api/webring/v1` with two queries, `webring` for the webring id, and `id` for your own website's id.

so, you are looking at a GET query that looks like  
`https://yyna.xyz/api/webring/v1?webring=awesome&id=me`

the response, and the global openapi spec can be found [here](https://yyna.xyz/_scalar#tag/webringv1/GET/api/webring/v1)

#### examples

- vue/nuxt.js: [yyna.xyz](https://git.yyna.xyz/yyna/v3.yyna.xyz/src/branch/main/site/app/components/WebringAutomatic.vue)