Skip to content

Commit

Permalink
Merge pull request #167 from pyrocumulus/fix-api-doc-links
Browse files Browse the repository at this point in the history
Release 0.11.2
  • Loading branch information
pyrocumulus authored May 4, 2023
2 parents 6f0e842 + 4e1aa8f commit ba0cae9
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docfx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Docfx

on:
push:
branches: [ master ]
branches: [ main ]

jobs:
build_and_test:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish-nuget.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: publish to nuget
on:
push:
branches:
- master # Default release branch
- main # Default release branch
jobs:
publish:
name: build, pack & publish
Expand Down
12 changes: 10 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,20 @@
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## Unreleased
## [0.11.2] - 2023-05-04

### Fixed

- Updated README formatting for NuGet package page [#132](https://github.com/pyrocumulus/pvoutput.net/pull/132)
- Updated all links to official API documentation [#133](https://github.com/pyrocumulus/pvoutput.net/pull/133)
- Fixed all API links from XML documentation [#133](https://github.com/pyrocumulus/pvoutput.net/pull/133)
- Updated API links from documentation page
- Updated documentation to reflect the rename of primary branch `master` to `main`

### Updated

- Updated `Microsoft.Extensions.Logging.Abstractions` from `v6.0.1` to `v7.0.0` [#147](https://github.com/pyrocumulus/pvoutput.net/pull/147)
- Updated `Microsoft.Extensions.DependencyInjection.Abstractions` from `v6.0.0` to `v7.0.0` [#151](https://github.com/pyrocumulus/pvoutput.net/pull/151)
- Updated `Tavis.UriTemplates` from `v1.1.1` to `v2.0.0` [#153](https://github.com/pyrocumulus/pvoutput.net/pull/153)

## [0.11.1] - 2022-07-24

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All other copyright for project PVOutput.Net are held by:

The MIT License (MIT)

Copyright (c) [2018 - 2020] Marcel Boersma and contributors.
Copyright (c) [2018 - 2023] Marcel Boersma and contributors.


Permission is hereby granted, free of charge, to any person obtaining a copy of
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> A .NET Core (Standard 2.0 compatible) wrapper library for API of the popular [PVOutput](https://pvoutput.org) service.
> PVOutput is a free service for sharing and comparing PV output data.
![GitHub last commit (master)](https://img.shields.io/github/last-commit/pyrocumulus/PVOutput.Net/master?label=last%20commit%20%28master%29)
![GitHub last commit (main)](https://img.shields.io/github/last-commit/pyrocumulus/PVOutput.Net/main?label=last%20commit%20%28main%29)
[![NuGet Version](https://img.shields.io/nuget/v/PVOutput.Net.svg?logo=nuget)](https://www.nuget.org/packages/PVOutput.Net/)
[![NuGet Downloads](https://img.shields.io/nuget/dt/PVOutput.Net.svg?logo=nuget)](https://www.nuget.org/packages/PVOutput.Net/)
[![.NET Core](https://img.shields.io/github/workflow/status/pyrocumulus/PVOutput.Net/.NET%20Core/develop)](https://github.com/pyrocumulus/pvoutput.net/actions?query=workflow%3A%22.NET+Core%22)
Expand All @@ -25,7 +25,8 @@ See [Changelog](CHANGELOG.md) for information on changes per version, including

This library is targeting .NET Standard 2.0 and above. For full compatibility details, check the [Microsoft Docs](https://docs.microsoft.com/nl-nl/dotnet/standard/net-standard#net-implementation-support).

**Please note**: The repository's default branch is `develop` containing bugfixes/features that are not yet available in the NuGet package. See [master](https://github.com/pyrocumulus/pvoutput.net/tree/master) branch for the source code, that was used for building the NuGet package.
**Please note:** that the default branch of the repository is `develop`. This means that it can contain bugfixes/features that are not yet available in the NuGet package.
See [main](https://github.com/pyrocumulus/pvoutput.net/tree/main) for the source code, that was used for building the NuGet package.

## Basic usage

Expand Down
2 changes: 1 addition & 1 deletion codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ codecov:
coverage:
precision: 2
round: down
range: "70..100
range: "70..100"
threshold: 2%

parsers:
Expand Down
40 changes: 20 additions & 20 deletions docfx/articles/coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ Currently all read operations of the API are implemented as are all of the opera

| Operation | Object | Module | Status | Documentation link |
|------------|--------------|-------------------|--------------------|-------------------------|
| Add | Output | Output | :heavy_check_mark: | [Add Output](https://pvoutput.org/help.html#api-addoutput) |
| Get | Output | Output | :heavy_check_mark: | [Get Output](https://pvoutput.org/help.html#api-getoutput) |
| Add | Status | Status | :heavy_check_mark: | [Add Status](https://pvoutput.org/help.html#api-addstatus) |
| Add | Batch Status | Status | :heavy_check_mark: | [Add Batch Status](https://pvoutput.org/help.html#api-addbatchstatus) |
| Get | Status | Status | :heavy_check_mark: | [Get Status](https://pvoutput.org/help.html#api-getstatus) |
| Delete | Status | Status | :heavy_check_mark: | [Delete Status](https://pvoutput.org/help.html#api-deletestatus) |
| Get | Statistic | Statistics | :heavy_check_mark: | [Get Statistic](https://pvoutput.org/help.html#api-getstatistic) |
| Get | System | System | :heavy_check_mark: | [Get System](https://pvoutput.org/help.html#api-getsystem) |
| Post | System | System | :heavy_check_mark: | [Post System](https://pvoutput.org/help.html#api-postsystem) |
| Get | Extended | Extended | :heavy_check_mark: | [Get Extended](https://pvoutput.org/help.html#api-getextended) |
| Get | Favourite | Favourite | :heavy_check_mark: | [Get Favourite](https://pvoutput.org/help.html#api-getfavourite) |
| Get | Missing | Missing | :heavy_check_mark: | [Get Missing](https://pvoutput.org/help.html#api-getmissing) |
| Get | Insolation | Insolation | :heavy_check_mark: | [Get Insolation](https://pvoutput.org/help.html#api-getinsolation) |
| Get | Team | Team | :heavy_check_mark: | [Get Team](https://pvoutput.org/help.html#api-getteam) |
| Join | Team | Team | :heavy_check_mark: | [Join Team](https://pvoutput.org/help.html#api-jointeam) |
| Leave | Team | Team | :heavy_check_mark: | [Leave Team](https://pvoutput.org/help.html#api-leaveteam) |
| Get | Supply | Supply | :heavy_check_mark: | [Get Supply](https://pvoutput.org/help.html#api-getsupply) |
| Search | Search | Search | :heavy_check_mark: | [Search](https://pvoutput.org/help.html#api-search) |
| Register | Notification | Notification | :heavy_check_mark: | [Register Notification](https://pvoutput.org/help.html#api-registernotification) |
| Deregister | Notification | Notification | :heavy_check_mark: | [Deregister Notification](https://pvoutput.org/help.html#api-deregisternotification) |
| Add | Output | Output | :heavy_check_mark: | [Add Output](https://pvoutput.org/help/api_specification.html#add-output-service) |
| Get | Output | Output | :heavy_check_mark: | [Get Output](https://pvoutput.org/help/api_specification.html#get-output-service) |
| Add | Status | Status | :heavy_check_mark: | [Add Status](https://pvoutput.org/help/api_specification.html#add-status-service) |
| Add | Batch Status | Status | :heavy_check_mark: | [Add Batch Status](https://pvoutput.org/help/api_specification.html#add-batch-status-service) |
| Get | Status | Status | :heavy_check_mark: | [Get Status](https://pvoutput.org/help/api_specification.html#get-status-service) |
| Delete | Status | Status | :heavy_check_mark: | [Delete Status](https://pvoutput.org/help/api_specification.html#delete-status-service) |
| Get | Statistic | Statistics | :heavy_check_mark: | [Get Statistic](https://pvoutput.org/help/api_specification.html#get-statistic-service) |
| Get | System | System | :heavy_check_mark: | [Get System](https://pvoutput.org/help/api_specification.html#get-system-service) |
| Post | System | System | :heavy_check_mark: | [Post System](https://pvoutput.org/help/api_specification.html#post-system-service) |
| Get | Extended | Extended | :heavy_check_mark: | [Get Extended](https://pvoutput.org/help/api_specification.html#get-extended-service) |
| Get | Favourite | Favourite | :heavy_check_mark: | [Get Favourite](https://pvoutput.org/help/api_specification.html#get-favourite-service) |
| Get | Missing | Missing | :heavy_check_mark: | [Get Missing](https://pvoutput.org/help/api_specification.html#get-missing-service) |
| Get | Insolation | Insolation | :heavy_check_mark: | [Get Insolation](https://pvoutput.org/help/api_specification.html#get-insolation-service) |
| Get | Team | Team | :heavy_check_mark: | [Get Team](https://pvoutput.org/help/api_specification.html#get-team-service) |
| Join | Team | Team | :heavy_check_mark: | [Join Team](https://pvoutput.org/help/api_specification.html#join-team-service) |
| Leave | Team | Team | :heavy_check_mark: | [Leave Team](https://pvoutput.org/help/api_specification.html#leave-team-service) |
| Get | Supply | Supply | :heavy_check_mark: | [Get Supply](https://pvoutput.org/help/api_specification.html#get-supply-service) |
| Search | Search | Search | :heavy_check_mark: | [Search](https://pvoutput.org/help/searching.html#searching) |
| Register | Notification | Notification | :heavy_check_mark: | [Register Notification](https://pvoutput.org/help/api_specification.html#register-notification-service) |
| Deregister | Notification | Notification | :heavy_check_mark: | [Deregister Notification](https://pvoutput.org/help/api_specification.html#deregister-notification-service) |
2 changes: 1 addition & 1 deletion docfx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ PM> Install-Package PVOutput.Net

## Changelog

See [Changelog](https://github.com/pyrocumulus/pvoutput.net/blob/master/CHANGELOG.md) for information on changes per version.To see coming but unreleased changes, see the `develop` branch.
See [Changelog](https://github.com/pyrocumulus/pvoutput.net/blob/main/CHANGELOG.md) for information on changes per version.To see coming but unreleased changes, see the `develop` branch.

## Support

Expand Down
2 changes: 1 addition & 1 deletion src/PVOutput.Net/Modules/Interfaces/IStatusService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public interface IStatusService

/// <summary>
/// Adds multiple statuses to the owned system.
/// <para>See the official <see href=https://pvoutput.org/help/api_specification.html#add-batch-status-service">API information</see>.</para>
/// <para>See the official <see href="https://pvoutput.org/help/api_specification.html#add-batch-status-service">API information</see>.</para>
/// Use the <see cref="StatusPostBuilder{IBatchStatusPost}"/> to create <see cref="IBatchStatusPost"/> objects.
/// </summary>
/// <param name="statuses">The statuses to add.</param>
Expand Down
2 changes: 1 addition & 1 deletion src/PVOutput.Net/PVOutput.Net.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageReleaseNotes>For release notes see:
https://github.com/pyrocumulus/pvoutput.net/blob/master/CHANGELOG.md</PackageReleaseNotes>
https://github.com/pyrocumulus/pvoutput.net/blob/main/CHANGELOG.md</PackageReleaseNotes>
<PackageId>PVOutput.Net</PackageId>
<PackageIcon>logo.png</PackageIcon>
<PackageReadmeFile>README.md</PackageReadmeFile>
Expand Down

0 comments on commit ba0cae9

Please sign in to comment.